Riders
Path Parameters
Response
application/json
Response
OK
TBD
Example:2023-01-01T12:00:00.000Z
Allowed values:BASERIDERBASEINCREASEINTEGRATEDRIDERRIDERINCREASEBENEFITDISCOUNTOTHERUNKNOWN
The specific name of the rider as designated by the insurance company. For example - Terminal Illness Accelerated Death Benefit
Example:Chronic Illness Accelerated Death Benefit Rider
Indicates the election status of the rider on the policy, specifying whether the policyholder has formally elected to include the rider
Example:ELECTED
A unique identifier or alphanumeric code assigned to the rider
Example:SBLCHR
Allowed values:APPROVEDDECLINED
This will be set to yes if there is no Child rider insured to support Unborn Child
Allowed values:true
Indicates whether the rider provides a qualified benefit under IRS or insurance regulations
Allowed values:true
Date on which Rider is selected and becomes effective on the policy
Example:2023-01-01
The date the policyholder elects to use or activate the rider benefit
Example:2023-01-01
The date on which the rider coverage ends/ is terminated
Example:2023-01-01
Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED
An unique identifier assigned to the rider coverage within an insurance coverage or policy layer
Example:Rider_SBLCHR
The total benefit amount the rider provides (separate from the base policy’s coverage.)
Example:0
The maximum benefit amount of the benefit base, policyholder can withdraw each year
Example:0
The Total Benefit Amount represents the maximum guaranteed amount available under the annuity rider over the life of the contract/rider
Example:0
The fixed percentage applied to the Rider Benefit Amount to calculate the annual guaranteed benefit amount
Example:100
Refers to a guaranteed payout to a beneficiary upon the death of the annuitant, regardless of the contract investment performance, as long as the annuity is in the accumulation phase. Used for Variable annuities
Example:0
The Growth Income Benefit value represents the guaranteed income base established under a Guaranteed Minimum Income Benefit (GMIB) rider. It is used to calculate the lifetime income payments the annuitant is entitled to upon annuitization, regardless of the contract actual account value.
Example:0
Amount that can be withdrawn without reducing the yearly or Lifetime rider benefit amount
Example:0
Note - Use riderParticipants field instead of riderParticipant
Show Child Parameters
Show Child Parameters
Show Child Parameters
The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage
Example:2.5
The maximum duration over which payments can be made under the rider ( in Months)
The current status of a claim filed under the rider
Allowed values:true
The date of the next scheduled review or re-evaluation of an ongoing claim (applicable for riders like chronic illness).
Example:2023-01-01
The date the benefit payout under the rider is to be disbursed to the policyholder or beneficiary
Example:2023-01-01
The amount paid under the rider benefit.(during a given payout cycle)
Example:0
Deprecated - kept for backwards compatibility
Example:0
The highest percentage of the policy’s face amount that can be accessed under the critical illness rider
Example:0
The percentage of the benefit payable under Tier 1 of the critical illness structure (e.g., for mild conditions).
Example:0
The maximum dollar amount payable under Tier 1 benefits
Example:0
The percentage of the benefit payable under Tier 2(usually for more severe conditions.)
Example:0
The maximum dollar amount payable under Tier 2 benefits.
Example:0
The date on which the Tier 1 critical illness rider benefit payment is scheduled or was made
Example:2023-01-01
The amount of benefit paid under the Tier 1 critical illness
Example:0
The date on which the Tier 2 critical illness rider benefit payment is scheduled or was made
Example:2023-01-01
The amount of benefit paid under the Tier 2 critical illness
Example:0
Show Child Parameters
The remaining benefit amount for the rider. Incremented by Premiums and adjusted by withdrawals.
Example:10.51
Indicates whether the ADL benefit is utilised on the contract.
Allowed values:true
The total guaranteed value the contract owner is entitled to at the end of the GMAB holding period — assuming no disqualifying withdrawals or events.
Example:5.17
Single or Joint Payout (not driven by Owners on the policy, even a jointly owned policy can have single as an option. Used in configuration to set different GMWB benefits for Single and Joint GMWB Amount Types
Allowed values:SINGLEJOINT
Ties to Withdrawal Reset Benefit % Annual Limit on Calender Processing if GMWB Anniversary Base reset is elected. Equals result of GMWB Benefit % equation box in Withdrawal tab (GMWB) Ku - Payout Factor Percentage of the benefit base that will be available for withdrawal each year
Example:1.23
GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events
Example:3.43
GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events
Example:5.45
The GMWB amount still available for withdrawal in the current Contract Year without creating an “Excess Withdrawal” situation.
Example:6.75
During the riders accumulation phase (before it is exercised), a hypothetical annual withdrawal limit is calculated and displayed on statements to inform the policyholder and assist in their decision to exercise the rider
Example:8.95
Indicator for whether the phase is Accumulation (not activated, benefit base is still accruing) or Income (annual limit calculated, benefit bases stop growing). Default value = Accumulation
Allowed values:ACCUMULATIONINCOME
User initiates the Reset, Variables product
Example:2023-01-01
Show Child Parameters
Authentication
Path Parameters
Parties
Query Parameters
Allowed values:OwnerJointOwnerAnnuitantJointAnnuitantPayeePayorThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiaryGrantorTrusteePowerOfAttorney
Path Parameters
Response
application/json
Response
OK
Allowed values:INDIVIDUALORGANIZATIONTRUST
TBD
The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)
Example:1
Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary
Example:100
Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent
Example:100
The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent
Example:3160000751
Allowed values:ACCOUNTMANAGERADDITIONALCOMPENSATIONRECIPIENTADVANCEDUNDERWRITINGCONSULTANTAGENCYORGENERALAGENTAGENCYDIRECTORAGENCYSUPERINTENDENTAGENCYVICEPRESIDENTAGENTORPRODUCERASSISTANTASSISTANTGROUPUNDERWRITERASSISTANTMANAGERASSISTANTVICEPRESIDENTASSISTANTVPCOMPLIANCEASSOCIATEAGENCYMANAGERASSOCIATEFINANCIALPLANNERASSOCIATEOFFICERMANAGERASSOCIATESALEDEVELOPMENTMANAGERINTRAININGASSOCIATESALESDEVELOPMENTMANAGERBANKBANKEMPLOYEEBRANCHMANAGERBROKERBROKERORDEALERBROKERAGEDIRECTORBROKERAGEGENERALAGENTCERTIFIEDFINANCIALPLANNERDISTRIBUTORFINANCIALCONSULTANTFINANCIALPLANNERMANAGINGDIRECTORMANAGINGGENERALAGENTOFFICEMANAGEROTHERPLATFORMREPQUALIFYINGOFFICERREGISTEREDFINANCIALPLANNERREGISTEREDREPRESENTATIVESALESDEVELOPMENTMANAGERSECONDLINEMANAGERSENIORADMINISTRATIVECONSULTANTSENIORADVANCEDUNDERWRITINGCONSULTANTSENIORFINANCIALPLANNERSENIORGROUPACCOUNTEXECUTIVESENIORGROUPSALESREPRESENTATIVESENIORPARTNERSENIORSALESDEVELOPMENTMANAGERSENIORVICEPRESIDENTSERVICINGBROKERSERVICINGONLYAGENTSOLICITORTEAMUNKNOWN
The first name of the party/trustee
Example:Karen
The middle name of the party/trustee
Example:Anne
The last name of the party/trustee
Example:Bates
The full name of the party/The legal name of the Trust/Organization
Example:Karen Anne Bates
Allowed values:MRMSMISSMRSDR
The suffix of the party name
Allowed values:JRSNSRIIIIIIIVVVIVII
Allowed values:MALEFEMALEUNISEX
The date of birth of the party
Example:2023-01-01
Gender Identity refers to an individual’s self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy
Example:TBD
Age calculated by date of birth and Policy year
Example:55
Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR
Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR
Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY
The name the organization is commonly known as
Example:TBD
The shortened/abbreviated version of the organization`s name that is unique to the organization
Example:TBD
Code to Identify organization
Example:TBD
Allowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATIONUNKNOWN
The trust agreement issued date to the party
Example:2023-01-01
The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy
Example:2023-01-01
Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY
Allowed values:INDIVIDUALTRUSTCORPORATETRUSTTESTAMENTARYTRUSTINTERVIVOSTRUSTGRANTORTRUST
The title of the trustee
Example:TBD
Access code of the trustee
Example:TBD
Allowed values:EMAILREGULARMAILPHONEFAXTEXTNOPREFERENCESPECIFIEDPOSTALOTHER
Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section
Example:1
The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping
Example:1
The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file
Example:1
The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party
Example:1
Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties
Example:12.1213
Show Child Parameters
Show Child Parameters
Show Child Parameters
Allowed values:APPROVEDNOTAPPROVEDPROCESSED
A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities
Allowed values:true
An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms
Allowed values:true
An indicator if the beneficiary is designated to be included in Joint RMD calculations
Allowed values:true
Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.
Example:2023-01-01
The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request.
Allowed values:PERSTIRPESDISTRIBUTION
Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions
Example:Party_PB_Primary_Bene_1
Array of addresses associated with the party
Show Child Parameters
Array of phone numbers associated with the party
Show Child Parameters
Array of emails associated with the party
Show Child Parameters
Array of bank accounts associated with the party
Show Child Parameters
Show Child Parameters
Show Child Parameters
TBD
Example:2023-01-01T12:00:00.000Z
Policy number
Example:ZH12345678
TBD
Example:0017b000010N4bCAAS
Show Child Parameters
Example:1
Authentication
Path Parameters
Query Parameters
Policy Illustration Information
Path Parameters
Response
application/json
Response
OK
LPSPayloadResponse
Attributes
Show Child Parameters
Account Value
Show Child Parameters
Test Value
Show Child Parameters
Death Benefit
Show Child Parameters
Coverage Value
Show Child Parameters
Array of Coverages
Show Child Parameters
Array of Parties
Show Child Parameters
Policy Fee
Show Child Parameters
Features
Show Child Parameters
Array of Fund Allocations
Show Child Parameters
Array of Funds
Show Child Parameters
Match Segment
Show Child Parameters
Array of Loan Segments
Show Child Parameters
Array of Arrangements
Show Child Parameters
Authentication
Path Parameters
Features
Path Parameters
Response
application/json
Response
OK
Allowed values:FREELOOKLAPSEASSESSMENTLAPSEPROTECTIONREINSTATEMENTRATELOCKANNUITIZATIONNONFORFEITUREOPTIONCONVERSIONDISCOUNTBILLINGCUSTOMFEATURE
A Feature Indicator in life insurance and annuities refers to a binary flag (Yes/No, True/False, or Enabled/Disabled) that signifies whether a specific policy feature, rider, or benefit is included in the contract. It helps insurers, agents, and policyholders quickly identify which optional or standard benefits apply to a policy
Allowed values:true
A Feature Option in life insurance and annuities refers to the specific choices or variations available within a policy feature, allowing customization based on the policyholder’s needs
Allowed values:LIFEONLYJOINTLIFEONLYJOINTANDSURVIVORPERIODCERTAINAMOUNTCERTAINLIFEWITHPERIODCERTAINLIFEWITHCASHREFUNDLIFEWITHINSTALLMENTREFUNDAUTOMATICPOLICYLOANREDUCEDPAIDUPAGEFACEAMOUNTLEGALOPERATIONALCOLLATERALLYASSIGNEDUNSPECIFIED
Reduced Paid-Up Face Amount is the new, lower death benefit that results when a policyholder elects the Reduced Paid-Up (RPU) insurance option on a permanent life insurance policy. Under this option, the policyholder uses the accumulated cash value of their policy to purchase a fully paid-up policy—meaning no further premiums are required—but with a reduced face amount compared to the original coverage
Example:46.49
Start date of the feature
Example:2023-01-01
End date of the feature
Example:2023-01-01
A Feature Status in life insurance and annuities indicates the current state or activation condition of a specific feature within a policy or contract. It reflects whether a feature is active, inactive, pending, or restricted, helping insurers, agents, and policyholders track policy functionality
Allowed values:true
The Period of Feature in life insurance and annuities refers to the duration for which a specific feature or benefit is available, active, or applicable within a policy or contract. It defines the time frame in which a feature can be used, exercised, or remains valid
Example:30
Effective date of the feature
Example:2023-01-01
The Total Minimum Required Amount refers to the lowest financial threshold needed to activate, maintain, or utilize a specific insurance or annuity feature. This can include minimum premiums, account balances, contributions, or fees necessary to keep the policy or benefit in force
Example:0
Min (This is if Carrier Acceot Min) - This is the Amount needed to reactivate the Policy (If there is an Outstanding Loan on the Policy Min Required Loan Balance will be part of this Amount)
Example:0
The Payment Amount for a Feature refers to the specific cost required to activate, maintain, or utilize a particular policy feature or rider in a life insurance or annuity contract. This amount can be a one-time payment, recurring charge, or deducted from policy values depending on the feature type
Example:46.49
The Fixed Exclusion Amount in the annuitization feature of an annuity refers to the portion of each annuity payment that is considered a return of the original investment (principal) and is therefore excluded from taxable income. This amount helps annuitants determine their tax liability on annuity payments
Example:46.49
The YTD Payment Amount for a Feature refers to the total amount paid or received for a specific policy feature from the beginning of the calendar year to the current date. This amount is commonly tracked for premiums, rider fees, annuity payouts, withdrawals, and other benefit-related transactions
Example:46.49
The Exclusion Ratio in annuitization refers to the portion of each annuity payment that is considered a return of the original investment (principal) and is therefore excluded from taxable income. It determines how much of an annuity payment is taxable and how much is tax-free.
Example:46.49
The Total Payment Amount of a Feature refers to the cumulative cost or sum of all payments made over time for a specific feature in a life insurance or annuity contract. This can include premiums, rider fees, annuity payouts, or benefit-related charges
Example:46.49
Joint Lives % to Survivor refers to the percentage of annuity payments that continue to the surviving annuitant after one of the joint annuitants passes away. It applies to Joint & Survivor Annuities, ensuring ongoing income for the surviving spouse or beneficiary.
Example:100
The Reinstatement Underwriting Decision refers to the evaluation process and approval or denial of a reinstatement request for a lapsed life insurance policy or annuity contract. When a policy lapses due to non-payment, the insurer requires underwriting to determine if the policy can be reinstated based on financial, medical, and risk factors
Allowed values:true
The Approval Date for a Feature refers to the official date on which an insurance company authorizes and activates a specific feature, rider, or benefit within a life insurance policy or annuity contract. This date marks when the feature becomes effective and available for use by the policyholder or annuitant
Example:2023-01-01
Unique identifier of feature sub-type for "custom feature
Example:123
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE
Gives the sub type of the feature type "Custom Feature
Allowed values:MULTIPLEPOLICYDISCOUNTCONTROLBUSINESSINDICATORRESTRICT
TBD
Example:2023-01-01T12:00:00.000Z
Authentication
Path Parameters
Distribution of Investments
Query Parameters
Path Parameters
Response
application/json
Response
OK
Allowed values:INVESTMENTFUNDINVESTMENTMODEL
Elect from available … If Owner picks and Model as an investment option
Example:TBD
The corresponding Model Id of the elected model
Example:TBD